[internal-dns] break types-only dependencies to dns-service-client #6807
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Created using spr 1.3.6-beta.1
sunshowers
commented
Oct 9, 2024
Comment on lines
-113
to
-144
| impl Ord for types::DnsRecord { | ||
| fn cmp(&self, other: &Self) -> std::cmp::Ordering { | ||
| use types::DnsRecord; | ||
| match (self, other) { | ||
| // Same kinds: compare the items in them | ||
| (DnsRecord::A(addr1), DnsRecord::A(addr2)) => addr1.cmp(addr2), | ||
| (DnsRecord::Aaaa(addr1), DnsRecord::Aaaa(addr2)) => { | ||
| addr1.cmp(addr2) | ||
| } | ||
| (DnsRecord::Srv(srv1), DnsRecord::Srv(srv2)) => srv1 | ||
| .target | ||
| .cmp(&srv2.target) | ||
| .then_with(|| srv1.port.cmp(&srv2.port)), | ||
|
|
||
| // Different kinds: define an arbitrary order among the kinds. | ||
| // We could use std::mem::discriminant() here but it'd be nice if | ||
| // this were stable over time. | ||
| // We define (arbitrarily): A < Aaaa < Srv | ||
| (DnsRecord::A(_), DnsRecord::Aaaa(_) | DnsRecord::Srv(_)) => { | ||
| std::cmp::Ordering::Less | ||
| } | ||
| (DnsRecord::Aaaa(_), DnsRecord::Srv(_)) => std::cmp::Ordering::Less, | ||
|
|
||
| // Anything else will result in "Greater". But let's be explicit. | ||
| (DnsRecord::Aaaa(_), DnsRecord::A(_)) | ||
| | (DnsRecord::Srv(_), DnsRecord::A(_)) | ||
| | (DnsRecord::Srv(_), DnsRecord::Aaaa(_)) => { | ||
| std::cmp::Ordering::Greater | ||
| } | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
This Ord impl should be identical to the automatically-derived one, since that orders stuff from top to bottom (so A, AAAA, and then SRV).
Created using spr 1.3.6-beta.1
sunshowers
commented
Oct 9, 2024
| ); | ||
|
|
||
| pub type DnsError = crate::Error<crate::types::Error>; |
There was a problem hiding this comment.
Moved DnsError here because it makes the most sense here.
Comment on lines
+403
to
+404
| Past versions of nexus-types that are still referenced in the dependency tree | ||
| depended on dns-service-client for defining some types. |
There was a problem hiding this comment.
So if I remove this rule as well, I get this diff:
DNS Server (client: dns-service-client)
+ consumed by: crucible-downstairs (crucible/downstairs)
+ consumed by: crucible-pantry (crucible/pantry)
+ consumed by: ddmd (maghemite/ddmd)
+ consumed by: dpd (dendrite/dpd)
+ consumed by: mgd (maghemite/mgd)
consumed by: omicron-nexus (omicron/nexus)
consumed by: omicron-sled-agent (omicron/sled-agent)
+ consumed by: propolis-server (propolis/bin/propolis-server)That's what I based this comment on.
Comment on lines
+76
to
+78
| "weight": 0, | ||
| "port": 127, | ||
| "target": "001de000-c04e-4000-8000-000000000002.host.control-plane.oxide.internal" |
There was a problem hiding this comment.
The reordering here is not important, it happened because we're no longer using progenitor-generated types (which I didn't realize got reordered in alphabetical order!)
jgallagher
approved these changes
Oct 10, 2024
| @@ -3062,7 +3062,6 @@ | |||
| ] | |||
| }, | |||
| "DnsConfigParams": { | |||
| "description": "DnsConfigParams\n\n<details><summary>JSON schema</summary>\n\n```json { \"type\": \"object\", \"required\": [ \"generation\", \"time_created\", \"zones\" ], \"properties\": { \"generation\": { \"type\": \"integer\", \"format\": \"uint64\", \"minimum\": 0.0 }, \"time_created\": { \"type\": \"string\", \"format\": \"date-time\" }, \"zones\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/components/schemas/DnsConfigZone\" } } } } ``` </details>", | |||
There was a problem hiding this comment.
I assume these descriptions were coming from progenitor - do we care that they aren't being replaced by something else?
There was a problem hiding this comment.
Yeah these descriptions are what happens when you use a progenitor-generated type in a Dropshot server, effectively doubling up on progenitor. I don't think it's a huge problem.
sunshowers
deleted the
sunshowers/spr/internal-dns-break-types-only-dependencies-to-dns-service-client
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, a number of crates across Omicron use
dns-service-clientjust forthe types, leading tools like
ls-apisto have to make exceptions to handlethem.
To resolve this, follow the pattern we've used in other places, particularly
while breaking dependency loops between API and client crates:
typescrate, in this caseinternal-dns-types, and move theshared types (currently in
dns-server-api) to the crate. This crate is agood place to put config code generally.
internal-dns-typeseverywhere viareplacedirectives.As a result of this, the only code that was left in
internal-dnswas theresolver -- so rename the crate to
internal-dns-resolverand move that tointernal-dns/resolver. Also move theinternal-dns-clicrate tointernal-dns/cli, since that is the general pattern we follow in Omicron.As a result of this change, code that just needs the types no longer needs to
depend on
dns-service-client, allowing us to remove one of the twodns-service-client-related rules. (I believe the other rule can be removedonce all our dependencies have been bumped.)
There are no changes to the output of
cargo xtask ls-apis apis.